FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource CapabilityStatement/FHIR Server from package virtually.healthcare#current (31 ms)

Package virtually.healthcare
Type CapabilityStatement
Id Id
FHIR Version R4
Source https://fhir.virtually.healthcare/https://build.fhir.org/ig/Virtually-Healthcare/Virtually-Healthcare-FHIR-Implementation-Guide/CapabilityStatement-PDSFacade.html
Url https://fhir.virtually.healthcare/CapabilityStatement/PDSFacade
Version 0.1.0-current
Status draft
Date 2024-10-08
Name FacadePersonalDemographicsService
Title Facade - Personal Demographics Service - FHIR API
Experimental False
Realm uk
Description This is a [Service Facade](ActorDefinition-ServiceFacade.html) to [Personal Demographics Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir) This facade is related to [IHE Patient Demographics Query for Mobile (PDQm)](https://profiles.ihe.net/ITI/PDQm/)
Kind requirements

Resources that use this resource

No resources found


Resources that this resource uses

StructureDefinition
Patient Patient
https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient UK Core Patient


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement PDSFacade

Facade - Personal Demographics Service - FHIR API

  • Implementation Guide Version: 0.1.0-current
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+xml, application/fhir+json
  • Supported Patch Formats:
  • Published on: 2024-10-08
  • Published by: Virtually Healthcare

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patienthttps://fhir.virtually.healthcare/StructureDefinition/Patient
Additional supported profiles:
  UK Core Patient
yyidentifier, name, family, given, birthdate, gender, death-date, address-postalcode, general-practitioner, email, phone

Resource Conformance: SHALL Patient

Base System Profile
Patient
Profile Conformance
SHALL
Reference Policy

Supported Profiles

UK Core Patient

Interaction summary
  • Supports read, search-type.

Documentation
GET /Patient?{parameters}

Conformance to this implementation guide SHOULD be tested via FHIR Validation.

Search Examples

Search for Patient's for a patient with a NHS Number of 9876543210

GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210
Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A patients NHS Number e.g. identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210

SHALLnamestring

A patients name

SHALLfamilystring

A patients surname

SHALLgivenstring

A patients first name

SHALLbirthdatedate

A patients date of birth

SHALLgendertoken

A patients gender - administrative

SHALLdeath-datetoken

A patients date of birth

SHALLaddress-postalcodestring

A patients postcode

SHALLgeneral-practitionertoken

A patients general practice

SHALLemailtoken

A patients email address

SHALLphonetoken

A patients phone number

 

Source

{
  "resourceType" : "CapabilityStatement",
  "id" : "PDSFacade",
  "text" : {
    "status" : "extensions",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement PDSFacade</b></p><a name=\"PDSFacade\"> </a><a name=\"hcPDSFacade\"> </a><a name=\"PDSFacade-en-GB\"> </a><h2 id=\"title\">Facade - Personal Demographics Service - FHIR API</h2><ul><li>Implementation Guide Version: 0.1.0-current </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+xml</code>, <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2024-10-08 </li><li>Published by: Virtually Healthcare </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#Patient1-1\">Patient</a></td><td><a href=\"StructureDefinition-Patient.html\">https://fhir.virtually.healthcare/StructureDefinition/Patient</a><br/><em>Additional supported profiles:</em><br/>��<a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\">UK Core Patient</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>identifier, name, family, given, birthdate, gender, death-date, address-postalcode, general-practitioner, email, phone</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"Patient1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>Patient</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-Patient.html\">Patient</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"https://simplifier.net/resolve?scope=fhir.r4.ukcore.stu2@2.1.0&amp;canonical=https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient\">UK Core Patient</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li>Supports <code>read</code>, <code>search-type</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><pre><code>GET /Patient?{parameters}\n</code></pre>\n<p>Conformance to this implementation guide <strong>SHOULD</strong> be tested via <a href=\"https://hl7.org/fhir/R4/validation.html\">FHIR Validation</a>.</p>\n<p><strong>Search Examples</strong></p>\n<p>Search for Patient's for a patient with a NHS Number of 9876543210</p>\n<pre><code>GET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210\n</code></pre>\n</div></blockquote></div></div><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>SHALL</b></td><td>identifier</td><td><code>token</code></td><td><div><p>A patients NHS Number e.g. <code>identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210</code></p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>name</td><td><code>string</code></td><td><div><p>A patients name</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>family</td><td><code>string</code></td><td><div><p>A patients surname</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>given</td><td><code>string</code></td><td><div><p>A patients first name</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>birthdate</td><td><code>date</code></td><td><div><p>A patients date of birth</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>gender</td><td><code>token</code></td><td><div><p>A patients gender - administrative</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>death-date</td><td><code>token</code></td><td><div><p>A patients date of birth</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>address-postalcode</td><td><code>string</code></td><td><div><p>A patients postcode</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>general-practitioner</td><td><code>token</code></td><td><div><p>A patients general practice</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>email</td><td><code>token</code></td><td><div><p>A patients email address</p>\n</div></td></tr><tr><td><b>SHALL</b></td><td>phone</td><td><code>token</code></td><td><div><p>A patients phone number</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">�</div></div></div></div></div></div>"
  },
  "url" : "https://fhir.virtually.healthcare/CapabilityStatement/PDSFacade",
  "version" : "0.1.0-current",
  "name" : "FacadePersonalDemographicsService",
  "title" : "Facade - Personal Demographics Service - FHIR API",
  "status" : "draft",
  "experimental" : false,
  "date" : "2024-10-08",
  "publisher" : "Virtually Healthcare",
  "contact" : [
    {
      "name" : "Virtually Healthcare",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://virtually.healthcare"
        }
      ]
    }
  ],
  "description" : "\nThis is a [Service Facade](ActorDefinition-ServiceFacade.html) to [Personal Demographics Service - FHIR API](https://digital.nhs.uk/developer/api-catalogue/personal-demographics-service-fhir)\n\nThis facade is related to [IHE Patient Demographics Query for Mobile (PDQm)](https://profiles.ihe.net/ITI/PDQm/)",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "GB",
          "display" : "United Kingdom of Great Britain and Northern Ireland"
        }
      ]
    }
  ],
  "kind" : "requirements",
  "fhirVersion" : "4.0.1",
  "format" : [
    "application/fhir+xml",
    "application/fhir+json"
  ],
  "rest" : [
    {
      "mode" : "server",
      "resource" : [
        {
          "extension" : [
            {
              "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode" : "SHALL"
            }
          ],
          "type" : "Patient",
          "profile" : "https://fhir.virtually.healthcare/StructureDefinition/Patient",
          "supportedProfile" : [
            "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Patient"
          ],
          "documentation" : "\n```\nGET /Patient?{parameters}\n```\n\nConformance to this implementation guide **SHOULD** be tested via [FHIR Validation](https://hl7.org/fhir/R4/validation.html).\n\n**Search Examples**\n\nSearch for Patient's for a patient with a NHS Number of 9876543210\n\n```\nGET /Patient?identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210\n```\n",
          "interaction" : [
            {
              "code" : "read"
            },
            {
              "code" : "search-type"
            }
          ],
          "searchParam" : [
            {
              "name" : "identifier",
              "type" : "token",
              "documentation" : "A patients NHS Number e.g. `identifier=https://fhir.nhs.uk/Id/nhs-number|9876543210`"
            },
            {
              "name" : "name",
              "type" : "string",
              "documentation" : "A patients name"
            },
            {
              "name" : "family",
              "type" : "string",
              "documentation" : "A patients surname"
            },
            {
              "name" : "given",
              "type" : "string",
              "documentation" : "A patients first name"
            },
            {
              "name" : "birthdate",
              "type" : "date",
              "documentation" : "A patients date of birth"
            },
            {
              "name" : "gender",
              "type" : "token",
              "documentation" : "A patients gender - administrative"
            },
            {
              "name" : "death-date",
              "type" : "token",
              "documentation" : "A patients date of birth"
            },
            {
              "name" : "address-postalcode",
              "type" : "string",
              "documentation" : "A patients postcode"
            },
            {
              "name" : "general-practitioner",
              "type" : "token",
              "documentation" : "A patients general practice"
            },
            {
              "name" : "email",
              "type" : "token",
              "documentation" : "A patients email address"
            },
            {
              "name" : "phone",
              "type" : "token",
              "documentation" : "A patients phone number"
            }
          ]
        }
      ]
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.